home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 43 / Amiga Format CD43 (1999)(Future Publishing)(GB)(Track 1 of 2)[!][issue 1999-09].iso / -serious- / comms / other / mdoors2 / multitop.doc < prev    next >
Text File  |  1999-06-14  |  9KB  |  229 lines
  1.  
  2. ---------------------------------------------------------------------------
  3.             MultiTop v2.0 [RELEASE 2] - Public Release Version!
  4.                      All Coding by Bobo (Mystic/X-Power)
  5. ---------------------------------------------------------------------------
  6.  
  7. Hi again, and welcome to another fine product from Mystic-Amiexpress.  Here
  8. it is - the new update  of MultiTop.  It have been completly rewritten, and
  9. today it's the DAMN best top utility available for amiexpress bbs.  It does
  10. not only allow you to make the most of your bulletins,  but also with  your
  11. own created design and much much more! (Continue reading)
  12.  
  13. Some notable features:
  14. ~~~~~~~~~~~~~~~~~~~~~~
  15. * MultiTop have a nice built in config program where you can configure your
  16.   personal settings.
  17. * MultiTop lets you make your own design.
  18. * MultiTop generates your top uploaders/downloaders (bytes and files),
  19.   top callers and top message writers.
  20. * MultiTop have been tested and works 100% on multinode systems.
  21. * MultiTop is written entirely in C for fast code.
  22. * MultiTop comes in 000 & 030 code to get the maximum speed on your system.
  23.   (please note that the 030 version will also work on 020 (a1200))
  24. * MultiTop have everything builtin. No need to create cfgs and such things,
  25.   you control everything in the cfg program.
  26. * Each design file can have its own personal configuration.
  27. * MultiTop can generate bulletins using your conference databases.
  28.   (You must have Conference Accounting activated to use this.)
  29. * MultiTop allow wildcards at the design argument.  This means that you can
  30.   have randomly top bulletins.
  31. * MultiTop can exclude users you don't want to have listed.
  32.  
  33. MultiTop is your final replacement for all your top makers. It doesn't only
  34. allow you to make your top uploaders bulletin, but also top callers and top
  35. message writers and much much more.
  36.  
  37. As you all probably know, there are perhaps fifty other top uploader  utils
  38. available for amiexpress today, and all of them with different designs.  It
  39. is always hard to choose between them,  becouse you really don't  know what
  40. design you want to use.  This problem is solved now,  becouse MultiTop lets
  41. you make your own design!
  42.  
  43. I hope that some of you design & ascii makers will create some nice designs
  44. for  this util  in the future.  This way there is no need to any other  top
  45. utility becouse all of them really works in the same way but with different
  46. designs.  HERE YOU GOT THE CODE - MAKE THE DESIGN!
  47.  
  48.  
  49. --------------------------------------------------( Usage and Examples )---
  50.  
  51. The usage of MultiTop is very simple, and it is the only thing you have  to
  52. "learn", if you ofcouse don't want to make your own designs!
  53.  
  54. Usage: MULTITOP <Design> <Output> [<Userdata>] [CONFDB <confdb>] [NOANSI]
  55.  
  56. <Design> : Full path to your designfile.  You may use AMIGADOS wildcards to
  57.            use random design files. (ie #?)
  58.  
  59. <Output> : Full path to your outputfile.  You may use a star (*) for output
  60.            directly to screen. (ie *)
  61.  
  62. [<Userdata>] : Full path to your userdata.  (BBS:User.Data is default)
  63.  
  64. [CONFDB <file>] : If you have conference accounting activated,  you can use
  65.                   conferences database to make the bulletins. <file> is the
  66.                   full path to your conf.db file.
  67.  
  68. [NOANSI] : Write a NO ANSI output. (Ansi is default)
  69.  
  70.  
  71. Some examples:
  72. ~~~~~~~~~~~~~~
  73. MULTITOP BBS:Designs/MTopULBytes#?.dsg BBS:Bull.txt SYS:User.Data NOANSI
  74. --- Generate a random TOP UPLOADERS bulletin using SYS:User.data with
  75.     NOANSI to BBS:Bull.txt
  76.  
  77. MULTITOP BBS:Designs/MTopULBytes#?.dsg BBS:Bull.txt CONFDB BBS:Conf2/Conf.db
  78. --- Generate a random TOP UPLOADERS bulletin from conference 2 to
  79.     BBS:Bull.txt
  80.  
  81. MULTITOP BBS:Designs/MTopMsgs1.dsg * NOANSI
  82. --- Generate a TOP MESSAGES bulletin (design 1) with NOANSI to screen.
  83.  
  84.  
  85. ----------------------------------------------( Design files - General )---
  86.  
  87. As you probably already figured out,  MultiTop needs a design file to work.
  88. A designfile is a normal textfile (ASCII)  created in a normal  text-editor
  89. with some keywords in it. The designfiles can also have its personal config
  90. in it. (explained later)
  91.  
  92. PLEASE NOTE
  93.  
  94. You don't have to make your own design if you don't have time or want  too.
  95. There are many nice designs delivered with this archive that's free to use,
  96. so if you aren't that good at painting etc, just use them. (This means that
  97. you DONT have to read the chapter about the design files)
  98.  
  99.  
  100. ----------------------------------( Design files - Keywords & Examples )---
  101.  
  102. LIST OF AVAILABLE KEYWORDS
  103.  
  104. USERINFO               BOARDINFO                   BOARDINFO (CONTINUATION)
  105. ~~~~~~~~               ~~~~~~~~~                   ~~~~~~~~~
  106. UN=UserName            TC=Total Calls              LT=Last Updated (Time)
  107. LT=Location            TM=Total Msgs               LD=Last Updated (Date)
  108. UB=Uploaded Bytes      UB=Total Uploaded Bytes     VT=Version Text
  109. UK=Uploaded K          UK=Total Uploaded K
  110. UM=Uploaded Megs       UM=Total Uploaded Megs
  111. UF=Uploaded Files      UF=Total Uploaded Files
  112. DB=Downloaded Bytes    DB=Total Downloaded Bytes
  113. DK=Downloaded K        DK=Total Downloaded K
  114. DM=Downloaded Megs     DM=Total Downloaded Megs
  115. DF=Downloaded Files    DF=Total Downloaded Files
  116. MS=Messages            SC=System Calls
  117. CS=Calls               TU=Total Active Users
  118. ST=Status              RG=Registered to
  119.  
  120. NOTE: The keyword VT *MUST* be used, or no output will be written.
  121.       It will insert a string (MultiTop v2.0) on 14 chars.
  122.  
  123.  
  124. USERINFO format:
  125. %<pos><center><length><keyword>  Example: %01-10UN
  126. |  |     |       |       |
  127. |  |     |       |       |> Userinfo Keyword
  128. |  |     |       |--------> Number of chars to display of keyword
  129. |  |     |----------------> Minus (-) for left, dot (.) for right
  130. |  |----------------------> User number from top
  131. |-------------------------> Keyword Identifer
  132.  
  133. BOARDINFO format:
  134. %<center><length><keyword>       Example: %-10VT
  135. |   |       |       |
  136. |   |       |       |-----> Boardinfo Keyword
  137. |   |       |-------------> Number of chars to display of keyword
  138. |   |---------------------> Minus (-) for left, dot (.) for right
  139. |-------------------------> Keyword Identifer
  140.  
  141. Examples
  142. ~~~~~~~~
  143. Username: [%01-10UN]  Location: [%01.10LT]  Bytes: [%01-10UB]
  144.  
  145. The above string would be translated to:
  146. Username: [bObO/mYSTi]  Location: [    mYStiC]  Bytes: [1,123,123 ]
  147.  
  148.  
  149. Total uploaded bytes: [%-10UB]  files: [%.00UF]
  150.  
  151. The above string would be translated to:
  152. Total uploaded bytes: [1,123,123]  files: [1,123]
  153.  
  154.  
  155. I recommend you to take a look  at the included example design-files  while
  156. reading this chapter to get hold of how it works.  I'm really sorry for not
  157. writing more information about this, but i hadn't got enough time. MultiTop
  158. have been lying here for almost 3 weeks finished and ready, but the doc was
  159. missing.  This weekend i decided that it MUST be released, therefor i wrote
  160. this doc in a hurry.  This means that there are probably some lame spelling
  161. mistakes and/or things missing in the document etc.  Once again i am sorry,
  162. but i hope you are smart enough to understand the most of it.
  163.  
  164.  
  165. ------------------------------------( Design files - Personal Settings )---
  166.  
  167. The design file(s) may have its own config in it. All of them are optional,
  168. but if you want to make an other output then top ulbytes,  you need to  use
  169. them.  Available commands/settings are:
  170.  
  171. SEPARATOR=DOT    - Use DOT (.) separator
  172.           COMMA  - Use COMMA (,) separator
  173.           NONE   - Donot use any separator
  174.  
  175. SORT=UPLOADEDBYTES    - Sort userlist by Uploaded Bytes (DEFAULT)
  176.      UPLOADEDFILES    - Sort userlist by Uploaded Bytes
  177.      DOWNLOADEDBYTES  - Sort userlist by Downloaded Bytes
  178.      DOWNLOADEDFILES  - Sort userlist by Downloaded Bytes
  179.      CALLS            - Sort userlist by Calls
  180.      MESSAGES         - Sort userlist by Messages
  181.  
  182. All lines in the designfile starting with '@' will *NOT* be written in  the
  183. output. @ followed by an option will active it. You may also use @ when you
  184. write comments in the designfile.
  185.  
  186.  
  187. EXAMPLES
  188. ~~~~~~~~
  189. @ This is a comment line
  190.  
  191. @SEPARATOR=DOT                    I can write whatever i want out here!
  192.  
  193. @SORT=DOWNLOADEDBYTES             I can write whatever i want out here!
  194.  
  195.  
  196. For more help and examples, take a look at the included designfiles.
  197.  
  198.  
  199. ------------------------------------------------------( Config program )---
  200.  
  201. MultiTop has a built in config program where you configure MultiTop. I wont
  202. go into details what every option do, becouse you'll see and find out!
  203.  
  204. To start the config program,  write "MULTITOP CFG" at the prompt,  or start
  205. MultiTop from workbench.
  206.  
  207.  
  208. -------------------------------------------------------------( The End )---
  209.  
  210. This program was written and developed (c)1993-1995 Bobo/Mystic using SAS/C
  211. (c) SAS Institute Inc.  You are free to use this util as long as you  want,
  212. but the  author is not responsible for any damages caused by this util.
  213.  
  214. If you want to contact me, feel free to call my board.
  215.  
  216. The East BBS: +46-8940614  [28.8 DS]      Logon as: GUEST
  217.               +46-8940615  [28.8 DS]      Password: PASSWORD
  218.               +46-8940919  [28.8 DS]
  219. Last Outpost: +31-72157682 [28.8 DS]
  220.               +31-72201182 [28.8 DS]
  221.  
  222.  
  223. LAST NOTE
  224. ~~~~~~~~~
  225. Everyone waiting for an update of WHAT (AEHydra) and FileDescription - just
  226. be patient.  The update is coming any time now.  The new WHAT will ofcourse
  227. support AEHydra and will show CPS rates etc!.  The new FILEDESCRIPTION will
  228. be better then ever - Just wait and see!
  229.